<html>
	<head>
		<title>supervisor</title>
<link href="../docs-assets/Breadcrumbs.css" rel="stylesheet" rev="stylesheet" type="text/css">
		<meta name="viewport" content="width=device-width initial-scale=1">
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
		<meta http-equiv="Content-Language" content="en-gb">

<link href="../docs-assets/Contents.css" rel="stylesheet" rev="stylesheet" type="text/css">
<link href="../docs-assets/Progress.css" rel="stylesheet" rev="stylesheet" type="text/css">
<link href="../docs-assets/Navigation.css" rel="stylesheet" rev="stylesheet" type="text/css">
<link href="../docs-assets/Fonts.css" rel="stylesheet" rev="stylesheet" type="text/css">
<link href="../docs-assets/Base.css" rel="stylesheet" rev="stylesheet" type="text/css">
		
	</head>
	<body class="commentary-font">
		<nav role="navigation">
		<h1><a href="../index.html"><img src="../docs-assets/Inform.png" height=72> </a></h1>
<ul><li><a href="../index.html">home</a></li>
</ul><h2>Compiler</h2><ul>
<li><a href="../structure.html">structure</a></li>
<li><a href="../inbuildn.html">inbuild</a></li>
<li><a href="../inform7n.html">inform7</a></li>
<li><a href="../intern.html">inter</a></li>
<li><a href="../services.html">services</a></li>
<li><a href="../secrets.html">secrets</a></li>
</ul><h2>Other Tools</h2><ul>
<li><a href="../inblorbn.html">inblorb</a></li>
<li><a href="../inform6.html">inform6</a></li>
<li><a href="../inpolicyn.html">inpolicy</a></li>
</ul><h2>Resources</h2><ul>
<li><a href="../extensions.html">extensions</a></li>
<li><a href="../kits.html">kits</a></li>
</ul><h2>Repository</h2><ul>
<li><a href="https://github.com/ganelson/inform"><img src="../docs-assets/github.png" height=0> github</a></li>
</ul><h2>Related Projects</h2><ul>
<li><a href="https://github.com/ganelson/inweb"><img src="../docs-assets/github.png" height=0> inweb</a></li>
<li><a href="https://github.com/ganelson/intest"><img src="../docs-assets/github.png" height=0> intest</a></li>
</ul>
		</nav>
		<main role="main">
		<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../inbuildn.html">Inbuild Modules</a></li><li><b>supervisor</b></li></ul>
		<p class="purpose">The central part of the build manager. This is version 1.</p>
		<hr>
		<div class="contentspage">
			<ul class="chapterlist">
				<li>
					<p class="chapterentry"><a name="P"></a>
						<span class="chaptertitle">Preliminaries</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="P-wtmd.html">
								<spon class="sectiontitle">What This Module Does</span></a> -
							<span class="sectionpurpose">An overview of the supervisor module's role and abilities.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="1"></a>
						<span class="chaptertitle">Chapter 1: Setting Up</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="1-sm.html">
								<spon class="sectiontitle">Supervisor Module</span></a> -
							<span class="sectionpurpose">Setting up the use of this module.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="1-ic.html">
								<spon class="sectiontitle">Inbuild Control</span></a> -
							<span class="sectionpurpose">Who shall supervise the supervisor? This section of code will.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="2"></a>
						<span class="chaptertitle">Chapter 2: Conceptual Framework</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="2-gnr.html">
								<spon class="sectiontitle">Genres</span></a> -
							<span class="sectionpurpose">The different sorts of work managed by inbuild.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-wrk.html">
								<spon class="sectiontitle">Works</span></a> -
							<span class="sectionpurpose">To store, hash code and compare title/author pairs used to identify works.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-edt.html">
								<spon class="sectiontitle">Editions</span></a> -
							<span class="sectionpurpose">An edition is a numbered version of a work.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-cps.html">
								<spon class="sectiontitle">Copies</span></a> -
							<span class="sectionpurpose">A copy is an instance in the file system of a specific edition of a work.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-ce.html">
								<spon class="sectiontitle">Copy Errors</span></a> -
							<span class="sectionpurpose">A copy error is attached to a copy when scanning it reveals some malformation.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-rqr.html">
								<spon class="sectiontitle">Requirements</span></a> -
							<span class="sectionpurpose">A requirement is a way to specify some subset of works: for example, those with a given title, and/or version number.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-nst.html">
								<spon class="sectiontitle">Nests</span></a> -
							<span class="sectionpurpose">Nests are repositories of Inform-related resources.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-rgs.html">
								<spon class="sectiontitle">Registries</span></a> -
							<span class="sectionpurpose">Registries are nests provided with metadata and intended to be presented as an online source from which Inform resources can be downloaded.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-jm.html">
								<spon class="sectiontitle">JSON Metadata</span></a> -
							<span class="sectionpurpose">Managing JSON-encoded metadata files for resources such as kits.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-lcn.html">
								<spon class="sectiontitle">Licences</span></a> -
							<span class="sectionpurpose">A copy of any genre can in principle have a licence declaration attached to it.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="3"></a>
						<span class="chaptertitle">Chapter 3: Incremental Builds</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="3-bg.html">
								<spon class="sectiontitle">Build Graphs</span></a> -
							<span class="sectionpurpose">Graphs in which vertices correspond to files or copies, and edges to dependencies between them.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="3-bm.html">
								<spon class="sectiontitle">Build Methodology</span></a> -
							<span class="sectionpurpose">Whether to run tasks internally in some merged tool, or run via the shell, or simply trace to the standard output what we think ought to be done.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="3-ib.html">
								<spon class="sectiontitle">Incremental Building</span></a> -
							<span class="sectionpurpose">Deciding what is the least possible amount which needs to be built, in what order, to arrive at a working version of a copy.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="3-bs.html">
								<spon class="sectiontitle">Build Scripts</span></a> -
							<span class="sectionpurpose">Scripts are nothing more than lists of build steps.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="3-bs2.html">
								<spon class="sectiontitle">Build Steps</span></a> -
							<span class="sectionpurpose">A build step is a task which exercises one of the build skills.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="3-is.html">
								<spon class="sectiontitle">Inter Skill</span></a> -
							<span class="sectionpurpose">The skills of kit building and of code generation from Inter.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="3-is2.html">
								<spon class="sectiontitle">Inform7 Skill</span></a> -
							<span class="sectionpurpose">The skill of turning source text into Inter code.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="3-is3.html">
								<spon class="sectiontitle">Inform6 Skill</span></a> -
							<span class="sectionpurpose">The skill of compiling Inform 6 into a story file for the target VM.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="3-is4.html">
								<spon class="sectiontitle">Inblorb Skill</span></a> -
							<span class="sectionpurpose">The skill of packaging a story file and associated resources into a blorb.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="4"></a>
						<span class="chaptertitle">Chapter 4: Genre Management</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="4-em.html">
								<spon class="sectiontitle">Extension Manager</span></a> -
							<span class="sectionpurpose">Claiming and creating copies of the extension genre: used for Inform 7 extensions.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-ebm.html">
								<spon class="sectiontitle">Extension Bundle Manager</span></a> -
							<span class="sectionpurpose">Claiming and creating copies of the kit genre: used for kits of precompiled Inter code.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-km.html">
								<spon class="sectiontitle">Kit Manager</span></a> -
							<span class="sectionpurpose">Claiming and creating copies of the kit genre: used for kits of precompiled Inter code.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-lm.html">
								<spon class="sectiontitle">Language Manager</span></a> -
							<span class="sectionpurpose">Claiming and creating copies of the language genre: used for bundles of natural language metadata in the Inform 7 compiler.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-pm.html">
								<spon class="sectiontitle">Pipeline Manager</span></a> -
							<span class="sectionpurpose">Claiming and creating copies of the pipeline genre: used for pipelines of code-generation stages.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-pbm.html">
								<spon class="sectiontitle">Project Bundle Manager</span></a> -
							<span class="sectionpurpose">Claiming and creating copies of the projectbundle genre: used for Inform 7 projects as created by the GUI apps.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-pfm.html">
								<spon class="sectiontitle">Project File Manager</span></a> -
							<span class="sectionpurpose">Claiming and creating copies of the projectfile genre: used for Inform 7 source texts stored as stand-alone plain text files, outside the GUI apps.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-tm.html">
								<spon class="sectiontitle">Template Manager</span></a> -
							<span class="sectionpurpose">Claiming and creating copies of the template genre: used for website and interpreter templates when releasing an Inform project.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="5"></a>
						<span class="chaptertitle">Chapter 5: Genre Services</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="5-es.html">
								<spon class="sectiontitle">Extension Services</span></a> -
							<span class="sectionpurpose">Behaviour specific to copies of the extension genre.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-ks.html">
								<spon class="sectiontitle">Kit Services</span></a> -
							<span class="sectionpurpose">Behaviour specific to copies of the kit genre.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-ls.html">
								<spon class="sectiontitle">Language Services</span></a> -
							<span class="sectionpurpose">Behaviour specific to copies of the language genre.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-ps.html">
								<spon class="sectiontitle">Pipeline Services</span></a> -
							<span class="sectionpurpose">Behaviour specific to copies of the pipeline genre.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-ps2.html">
								<spon class="sectiontitle">Project Services</span></a> -
							<span class="sectionpurpose">Behaviour specific to copies of either the projectbundle or projectfile genres.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-ts.html">
								<spon class="sectiontitle">Template Services</span></a> -
							<span class="sectionpurpose">Behaviour specific to copies of the template genre.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="6"></a>
						<span class="chaptertitle">Chapter 6: Inform Source Text</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="6-st.html">
								<spon class="sectiontitle">Source Text</span></a> -
							<span class="sectionpurpose">Using the lexer and syntax analysis modules to read in Inform 7 source text.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="6-hdn.html">
								<spon class="sectiontitle">Headings</span></a> -
							<span class="sectionpurpose">To keep track of the hierarchy of headings and subheadings found in the source text.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="6-tof.html">
								<spon class="sectiontitle">The Options File</span></a> -
							<span class="sectionpurpose">The optional file of Options applied to all of the user's projects.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="6-inc.html">
								<spon class="sectiontitle">Inclusions</span></a> -
							<span class="sectionpurpose">To fulfill requests to include extensions, adding their material to the parse tree as needed, and removing INCLUDE nodes.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="6-cs.html">
								<spon class="sectiontitle">Control Structures</span></a> -
							<span class="sectionpurpose">To specify the syntax of control structures such as repeat, if and otherwise.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="6-vmg.html">
								<spon class="sectiontitle">Virtual Machine Grammar</span></a> -
							<span class="sectionpurpose">Grammar for parsing natural language descriptions of a virtual machine.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="7"></a>
						<span class="chaptertitle">Chapter 7: Extension Management</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="7-tm.html">
								<spon class="sectiontitle">The Mini-Website</span></a> -
							<span class="sectionpurpose">To refresh the mini-website of available extensions presented in the Inform GUI applications.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-eip.html">
								<spon class="sectiontitle">Extensions Index Page</span></a> -
							<span class="sectionpurpose">To generate the index page for the extension mini-website, which is the home page displayed in the Extensions tab for the Inform GUI apps.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-ti.html">
								<spon class="sectiontitle">The Installer</span></a> -
							<span class="sectionpurpose">To install or uninstall an extension into an Inform project, producing an HTML page as a report on what happened.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-tc.html">
								<spon class="sectiontitle">The Converter</span></a> -
							<span class="sectionpurpose">To convert an extension from the traditional one-file format to the more modern directory-based format.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-dc.html">
								<spon class="sectiontitle">Documentation Compiler</span></a> -
							<span class="sectionpurpose">To compile documentation from the textual syntax in an extension into a tree.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-dr.html">
								<spon class="sectiontitle">Documentation Renderer</span></a> -
							<span class="sectionpurpose">To render a passage of extension documentation as HTML.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-im.html">
								<spon class="sectiontitle">In-App Manuals</span></a> -
							<span class="sectionpurpose">Adaptations to extension documentation for rendering inside the app.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-mrp.html">
								<spon class="sectiontitle">Making RTP Pages</span></a> -
							<span class="sectionpurpose">To turn Markdown source into outcome or run-time-problem pages.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-id.html">
								<spon class="sectiontitle">Indexing Data</span></a> -
							<span class="sectionpurpose">A set of compiled documentation has some notations for indexing, some categories for its index entries, and a collection of "lemmas", or entries.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-it.html">
								<spon class="sectiontitle">Index Terms</span></a> -
							<span class="sectionpurpose">Hypothetical index entries with no references to position as yet.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-il.html">
								<spon class="sectiontitle">Index Lemmas</span></a> -
							<span class="sectionpurpose">To scan a Markdown tree of documentation and accumulate a set of index lemmas.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-imn.html">
								<spon class="sectiontitle">Index Markup Notations</span></a> -
							<span class="sectionpurpose">Lemmas are marked up semantically using all sorts of notations.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-gi.html">
								<spon class="sectiontitle">General Index</span></a> -
							<span class="sectionpurpose">To render a documentation index into HTML form.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="7-ei.html">
								<spon class="sectiontitle">Examples Index</span></a> -
							<span class="sectionpurpose">To produces the contents and indexing pages, for HTML output and multiple-files mode only.</span></p>
						</li>
					</ul>
				</li>
			</ul>
		</div>
		<hr>
		<p class="purpose">Powered by <a href="https://github.com/ganelson/inweb">Inweb</a>.</p>
		</main>
	</body>
</html>

